CygNet DDS Command Copy Utility

Devices > Device Utilities > DDS Command Copy Utility

CygNet DDS Command Copy Utility

Use the CygNet DDS Command Copy utility (DdsCommandCopy.exe) to copy UIS commands from one remote device to other devices within the same Device Definition Service (DDS). You can make several different kinds of changes in a single copy action, including updating one or many commands within a single remote device, selected remote devices, or all remote devices of a certain type; deleting replaced commands; and updating command components in destination commands.

Best practice recommends that you first perform a copy in Test Mode Only. This produces a report at the bottom of the CygNet DDS Command Copy dialog box listing what changes would occur upon execution, and gives you the opportunity to make any necessary adjustments before proceeding.

The CygNet DDS Command Copy utility file (DdsCommandCopy.exe) is stored in the CygNet\Utilities directory on your host server.

Note: If you want to make similar changes to data groups, see CygNet DDS Data Group Copy Utility.

Starting DDS Command Copy

Installing and Launching

To install and launch (start) the application or utility using version management:

Use CygNet Client Installer to install and launch the application. Once installed you can use CygNet Client Installer to start the application.

-OR-

If previously installed, click Start > All Programs > CygNet > <name of the application or utility> or double-click the desktop shortcut.

Alternatively, browse to the CygNet\Utilities directory using Windows Explorer and double-click the program icon. You can also start an application or utility from a command line. These methods do not provide version management.

The CygNet DDS Command Copy dialog box appears.

Sample CygNet DDS Command Copy Dialog Box

Using the CygNet DDS Command Copy Utility

Using the CygNet DDS Command Copy Utility involves deciding which UIS commands you want to copy to which remote device(s) and with what effects on the destination remote device(s).

Specifically, use the CygNet DDS Command Copy Utility to add, update, replace, and delete commands. The difference between updating a command and replacing a command is that with updating you can specify a subset of items to update within the command, whereas replacing the command is identical to deleting the command and adding it again.

When the Add/Update or Update Only options are selected in the Copy Options panel, the Update Options become available. You can select to update any or all of these items. If none of these items are selected, no changes are made to the command in the destination remote device.

To Copy Commands

Note: Best practice recommends copying commands in Test Mode Only first. Then, when you are ready to copy to a live remote device, copy to a single remote device and verify your results before copying to multiple remote devices.

Open the DDS Command Copy utility, to access the CygNet DDS Command Copy dialog box.
Select the Test Mode Only check box to ensure that you do not mistakenly copy commands before you have reviewed the changes.
Provide information about the source and target devices and commands to copy. See the CygNet DDS Command Copy Utility Properties table for more information.

In the Copy From group box, provide information about the source device and commands.

In the DDS Site.Service field, browse for the DDS that contains the commands you want to modify and select it.
In the Device ID to Copy field, browse for the remote device you want to copy commands from and select it.
Click Load Command List to load all of the commands for the selected device ID into the Commands to Copy pane.
Select commands to copy in the Commands to Copy pane. To select multiple commands at once, press Shift or Ctrl + the desired command names.

In the Copy To group box, provide information about the target device(s) to copy the commands to.
In the Copy Options group box, select the copy options to use.
If an "update" copy option is selected (either Add/Update or Update Only), the Update Options group box becomes available. Select the update options to use. See To Select Specific Command Components for Copy for more information about selecting specific command components to copy.
Select the action to take If Component Is Missing On Destination Device.

Test the command copy action.

When you have provided all necessary information, click Copy to test the copy action.
A report will be generated in the pane at the bottom of the CygNet DDS Command Copy dialog box, listing the changes.
Review and verify the changes.
If you want to save a file of your changes, click Copy Log to Clipboard and paste the log into a text editor of your choice. The log information can be helpful to troubleshoot errors in a real copy action.
If necessary, adjust any settings or properties and repeat steps 3 and 4 until the results are satisfactory.

Perform the command copy action.
Note: Best practice recommends selecting only one remote device for your first live copy.

When you are satisfied with your test copy results, clear the Test Mode Only check box and click Copy to perform a "live" copy.
Results from your live copy appear in the pane at the bottom of the CygNet DDS Command Copy dialog box.

To Select Specific Command Components for Copy

In the Copy Options group box, click a copy option that includes updating (Add/Update or Update Only). The Update Options group box becomes accessible.
In the Update Options group box, select the Components update option and then click Options to access the Advanced Component Options dialog box and do one of the following.
- To replace all of the components, click Replace Whole List, and then click OK.
- To replace only selected components, click Add Selected Components, click to select the components to update, and then click OK.

CygNet DDS Command Copy Utility Properties

The following table provides details about the properties of the CygNet DDS Command Copy dialog box.

Property	Description
General
Copy	Click to perform a copy of all selected commands within the Commands to Copy field.
Close	Click to close the CygNet DDS Command Copy dialog box.
Test Mode Only	Check to enable Test Mode. When running in Test Mode, the status bar towards the bottom of the dialog box identifies the action as SIMULATION. The numbers next to each operation are the elapsed processing time in seconds.
Copy Log to Clipboard	Click to copy a log to the clipboard for output to a text file of your choice.
Clear	Click to clear the copy log between copies.
If Component Is Missing on Destination Device	Three options are available when copying commands when a command component is missing on the destination device: Skip Command — skips command creation entirely if the command is missing components. Drop Component — Add/Update Copy Option: If all components are dropped because they are missing, skips command creation entirely. Otherwise, creates the command with available components only. Update Only Copy Option: Adds the command to the destination device if the component exists on source device but not on destination device. Updates the command if the component exists on both source device and destination device. Deletes the component if the component does not exist on the source device but does exist on the destination device. Deletes the command entirely if the destination list is empty or all components are marked to be removed.
Copy From
DDS Site.Service	The site and DDS service from which you want to copy commands or some of their properties.
Device ID to Copy	The device ID of the remote device you want to use as your command source remote device.
Commands to Copy	This field lists all commands individually or by type for a specified device ID. Includes ordinal, description, and facility.
Load Command List	Click to display all commands individually or by type for a specified device ID.
Copy To
All devices where type matches device ID to copy	All remote devices of the same remote device type as the source device. This is the most common option.
All devices of type	All remote devices of a designated type, but which are not the same as the source remote device type. Note: When copying commands from one remote device type to another, be sure that the destination device(s) support the copied commands. Copying from one type to another is usually only valid for remote device types from the same manufacturer or for user-configured remote devices, like Modbus remote devices.
Selected devices	A list of specific, individual remote devices. Multiple individual devices can be selected at once. Note: When copying commands from one remote device type to another, be sure that the destination device(s) support the copied commands. Copying from one type to another is usually only valid for remote device types from the same manufacturer or for user-configured remote devices, like Modbus remote devices.
Imported devices
Copy Options
Add/Update	If a source command is present in the destination device, update the command. Otherwise, add the command. Selecting this option enables Update Options. See If Component Is Missing on Destination Device for information on how command components are handled when missing on the destination device.
Update Only	If a source command is present in the destination device, update the command. Otherwise, do nothing. Selecting this option enables Update Options. See If Component Is Missing on Destination Device for information on how command components are handled when missing on the destination device.
Add Only	Add the source command to the destination remote device if it does not already exist. If it does exist, do nothing.
Add/Replace	If a source command is present in the destination remote device, replace the command with the source command. Otherwise, add the command.
Replace Only	If a source command is present in the destination remote device, replace the command with the source command. Otherwise, do nothing.
Delete	If a source command is present in the destination device, delete the command from the destination device. Otherwise, do nothing.
Update Options
Description	Check to update the destination command description with the source command description.
Parameters	Check to update the destination command parameters with the source command parameters.
Can Schedule	Check to update the destination Can Schedule option with the source Can Schedule option.
Security Info	Check to update the destination command security settings with the source command security settings.
Components	Check to update the destination command components with the source command components. When selected, the Options button becomes available.
Options	When Components is selected, click Options to access selection of specific command components to update. Use this option to change or add components to the destination device. For more information, see To Select Specific Command Components for Copy.

Common Copy Errors and Warnings

The following table provides details about common error and warning messages of the CygNet DDS Command Copy dialog box.

Message	Description
Error Message
DDS has uninitialized facility ordinals. Run DDS Load to correct.	This message is displayed if a destination remote device has facilities for which the ordinal is -1. See CygNet DDS Import/Export Utility.
Advanced Component Options unavailable if more than one From command selected.	Occurs when the Options button is pressed, but more than one command is selected. Select one command at a time to use advanced UDC options.
Log Error Message
You must have DDS Database administrator rights to run this program.	This is a security issue. You must have administrator permission for the DDS ACCESS event to run this program. Contact your CygNet system administrator.